/*
 * Copyright (C) 2011-2013 Eric Lasota
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef __RDX_CALLBACKS_HPP__
#define __RDX_CALLBACKS_HPP__

namespace RDX
{
	struct OperationContext;

	namespace ObjectManagement
	{
		struct IObjectManager;
	}

	namespace Programmability
	{
		struct Method;
		struct RuntimeThread;
		union RuntimeStackValue;

		typedef int (RDX_DECL_API *NativeCallback) (OperationContext *ctx, ObjectManagement::IObjectManager *objm, const Method *m, RuntimeThread *thread,
			RuntimeStackValue *prv);
		
		// SUPER IMPORTANT:
		// These two functions are NOT reverses of each other!  IPToCurrentInstructionCallback returns the instruction being executed when
		// the IP is set to a specified value, which is the instruction BEFORE the IP.  InstrNumToIPCallback converts an instruction number
		// to the IP neccessary to run that instruction next.

		// InstrNumToIP(IPToCurrentInstruction(ip) + 1) == ip
		typedef LargeInt (RDX_DECL_API *IPToCurrentInstructionCallback) (const Method *method, const void *ip);
		typedef const void *(RDX_DECL_API *InstrNumToIPCallback) (OperationContext *ctx, const Method *method, LargeInt instrNum, bool *resumeAllowed);
		
		typedef int (RDX_DECL_API *ResumeThreadCallback) (OperationContext *ctx, ObjectManagement::IObjectManager *objm, RuntimeThread *t);
	}
}

#endif
